home *** CD-ROM | disk | FTP | other *** search
/ SGI Developer Toolbox 6.1 / SGI Developer Toolbox 6.1 - Disc 1.iso / toolbox / searchtools / oasisIII.README < prev    next >
Text File  |  1996-11-11  |  32KB  |  772 lines
  1.  
  2.                  Developer Toolbox version 5.0 sifttree README
  3.  
  4.  
  5.                                README CONTENTS:
  6.  
  7.        1. Standalone Operation Notes
  8.        2. Software Installation for System-Wide/Web Server Operation/Access
  9.        3. Ascii version of older OasisIII On-line Help Book
  10.  
  11.  
  12.  
  13. 1. Standalone Operation Notes:
  14.  
  15.     "sifttree" is a script located at the top-of-tree v5.0 Toolbox CD that 
  16.     first fires up a server program, oksvr, and then invokes a client 
  17.     Graphical User Interface (GUI) motif-based program, oasisIII, used for
  18.     information retrieval.  oasisIII/oksvr are a client/server pair.  
  19.     Together, they provide a powerful search mechanism for examining 
  20.     user-specified keyword lists, titles, and filenames throughout the 
  21.     entire Toolbox tree.
  22.  
  23.     Through the oksvr, "sifttree" accesses index database files for the 
  24.     ENTIRE contents of this CD.  When the OasisIII window comes up, notice 
  25.     only the "Toolbox" node is active--this is so that by default, the 
  26.     whole tree is searched.  To select only a subset to conduct your 
  27.     searches in, press on the "Toolbox" node to de-select it (i.e. the
  28.     whole tree), and select just the subtree(s) you wish to conduct searches
  29.     within.
  30.  
  31.     When quitting out of oasisIII, you'll need to wait approximately one 
  32.     minute before successfully starting up "sifttree" again.  As explained by 
  33.     an in-house netgaud, when asked, 
  34.        `What is this 1 minute delay?'
  35.        `It's a TCP thing--in order to be "a reliable delivery mechanism", 
  36.        tcp says it has to wait around a bit after it wants to die so 
  37.        clients can flush themselves.'  
  38.     The behavior one will see if one *doesn't* wait long enuff will be the 
  39.     message,
  40.  
  41. INITREQMSG: Send Communication Error
  42.     
  43.     coming out in the shell window "sifttree" was invoked from, and a notifier
  44.     window which will come up saying,
  45.  
  46. Initialization failed.
  47.  
  48. Problem communicating with server process (oksvr)
  49. on host localhost
  50.  
  51.     Again, wait one minute and then invoke "sifttree" again. 
  52.  
  53.     Remember, the oksvr program that is started first inside the "sifttree"
  54.     script is a server--once it's fired up, it will continue to run until 
  55.     you exit the OasisIII window.  As long as oksvr is running there will be
  56.     a file, /usr/tmp/ft*.tmp, that is used as a memory nexus.  As long as 
  57.     oksvr is "properly" terminated (i.e. exiting OasisIII), this file will 
  58.     automatically be removed.
  59.  
  60.  
  61.   ____________________________________________________________________________
  62.  
  63.  
  64.  
  65. 2. Software Installation for System-Wide/Web Server Operation/Access
  66.  
  67.  
  68. THIS IS A TEXT-ONLY VERSION OF THE sifttree.html FILE:
  69.  
  70. This document desribes the two methods available to conduct search queries on
  71. the Toolbox CD in v5.0 using the OasisIII client program in concert with the
  72. oksvr server program.
  73.  
  74. The two methods are based upon whether one is running an HTTP server or not.
  75. The document describing v5.0 HTML Operability and Limitations explains the HTML
  76. (client) and HTTP (server) issues relating to these two distinct environments
  77. in which v5.0 will operate. If you haven't read about this yet, you should
  78. before you proceed further with this one.
  79.  
  80. Again, there are two distinct environments within version 5.0 to describe here:
  81.  
  82.   1. If you are running an http server, and
  83.   2. If you are not running an http server
  84.  
  85.   1. If you are running an http server, and have re-configured the server so it
  86.      knows about the location of the /toolbox/www/cgi-bin scripts directory and
  87.      files, then you will be able to access any of the Search links in the
  88.      .html files scattered throughout the toolbox tree.
  89.  
  90.      But before you can do this you must install the oasisIII inst image. The
  91.      inst files for this lives in toolbox/searchtools/dist. A listing of the
  92.      subsystem sizes and all files loaded is included as well. The five
  93.      subsytems indicated--books.help, man.oasisIII, man.relnotes, sw.client,
  94.      sw.server--are those the janitor recommends you load. At a very minimum,
  95.      you must load the complete oasisIII.sw image.
  96.  
  97.      Once you have installed the oasisIII software, you must ensure the script
  98.      /etc/init.d/okserver is correctly configured to run the server,
  99.      /usr/sbin/oksvr, every time the machine boots up, or, if the root user
  100.      executes:
  101.           /etc/init.d/okserver start
  102.  
  103.      To stop the okserver root user executes:
  104.           /etc/init.d/okserver stop
  105.      and to prevent it from being started everytime the system boots up, as
  106.      root run:
  107.           chkconfig okserver off
  108.  
  109.      And finally, you must ensure that both the /etc/init.d/okserver and
  110.      www/cgi-bin/osearch-cgi scripts are correctly configured to reference the
  111.      actual location of the "searchtools" directory (currently located in the
  112.      top-of-tree). There are two distinct configurations that can occur here:
  113.  
  114.        1. Linking /CDROM to /Your/DocumentRoot/toolbox. This means you are
  115.           dedicating a CDROM drive to housing the v5.0 Toolbox CD.
  116.  
  117.           In this case, the /etc/init.d/okserver and the
  118.           www/cgi-bin/osearch-cgi script are all set to go.
  119.  
  120.        2. Copying /CDROM to /Your/DocumentRoot/toolbox. This means are
  121.           dedicating 380+MB of local disk space needed house the Toolbox on
  122.           your local system disk(s).
  123.  
  124.           In this case, you will need to change the value of the OKSVR_ROOT
  125.           environment variable in /etc/init.d/okserver, and create a file in
  126.           /usr/tmp/.DT_OksvrRoot that replicates the value of OKSVR_ROOT.
  127.           Quoting from the top of /etc/init.d/okserver,
  128.  
  129. #       This is the oksvr /etc/init.d/okserver startup script for
  130. #       The Developer Toolbox, version 5.0 CD, released, March 1995.
  131. #       The key to running this script correctly is to always ensure
  132. #       that the
  133. #
  134. #            OKSVR_ROOT
  135. #
  136. #       shell variable is defined to point to the absolute path location
  137. #       where the "searchtools" directory exists.  By default this
  138. #       location is defined to be  "/CDROM/searchtools".  If one is
  139. #       running an HTTP server and wants to create a child directory
  140. #       of the HTTP server's Document Root to place the contents of
  141. #       this toolbox in, the OKSVR_ROOT variable will need to be
  142. #       redefined to properly point to the new "active" location of
  143. #       "searchtools".  For example, suppose the HTTP server's
  144. #       Document Root is "/usr/local/www", and a directory under this
  145. #       named "toolbox" is created to house the contents of the v5.0
  146. #       CD.  Then, the default OKSVR_ROOT definition would change from,
  147. #
  148. #            OKSVR_ROOT=/CDROM/searchtools
  149. #
  150. #       to now be,
  151. #
  152. #            OKSVR_ROOT=/usr/local/www/toolbox/searchtools
  153.  
  154.           Thus, for the sake of example, we'll say that your Document Root is
  155.           defined to be /usr/local/www, and the Toolbox tree hangs off of it in
  156.           a subdirectory called toolbox. Now, to examine the remaining half of
  157.           this puzzle, we quote from the top of www/cgi-bin/osearch-cgi,
  158.  
  159. # DEFINE WHAT THE FULSEARCH PATH WILL BE SO WE CAN BUILD THE URLs:
  160. #
  161. # Make sure the value of the $OksvrSearchRoot variable inside the
  162. # /usr/tmp/.DT_OksvrRoot file, specified below, is equivalent
  163. # to what the OKSVR_ROOT variable is defined to be inside the
  164. # /etc/init.d/okserver script.
  165. # For example, if /etc/init.d/okserver has defined:
  166. # OKSVR_ROOT=/usr/local/www/toolbox/searchtools
  167. # then the /usr/tmp/.DT_OksvrRoot file should consist of the
  168. # following (starting from and including the `$' (dollar) sign:
  169. #    $OksvrSearchRoot="/usr/local/www/toolbox/searchtools" ;
  170. #
  171. if (-f "/usr/tmp/.DT_OksvrRoot") {
  172.     eval (`cat "/usr/tmp/.DT_OksvrRoot"`) ;
  173. }
  174. else {
  175.     $OksvrSearchRoot="/CDROM/searchtools" ;
  176. }
  177.  
  178.           Hence you would need to make the contents of the
  179.           /usr/tmp/.DT_OksvrRoot file be:
  180.  
  181.           $OksvrSearchRoot="/usr/local/www/toolbox/searchtools" ;
  182.  
  183.           At this point, with the /usr/tmp/.DT_OksvrRoot file defined to
  184.           reflect the current location of the searchtools subtree, and the
  185.           /etc/init.d/okserver started up with OKSVR_ROOT defined with the same
  186.           absolute path value, you should have a functional search engine
  187.           capability inside your local webDT site.
  188.  
  189.           If you have any problems with any of this, please feel free to
  190.           contact the janitor @ dave@sgi.com, 415/390-3556, or fax:
  191.           415/967-6239.
  192.  
  193.      Once the oksvr is running, search queries can be initiated from within the
  194.      Developer Toolbox: Oasis Search Engine form access via any "Seach" link
  195.      available on most every .html file document throughout the toolbox.
  196.  
  197.      If you are not running an http server, you won't be able to conduct
  198.      searches by accessing any "Search" links from within the netscape browser.
  199.  
  200.      Instead, you can use the sifttree script located in the top-of-tree
  201.      toolbox directory. This will run via copies of oksvr and oasisIII located
  202.      in the searchtools subdirectory--you don't need to install the oasisIII
  203.      inst image software if you are going to simply run the sifttree
  204.      script--and will invoke a motif-based-GUI version of oasisIII, similar to
  205.      what has been included on the Toolbox in the past.
  206.  
  207.      Through this motif-version of oasisIII you can perform all the sorts of
  208.      multiple-keyword queries, etc., that has been possible with the oasisIII
  209.      software in past toolboxes via the sifttree script.
  210.  
  211.      In order to access the on-line help inside the oasisIII application, you
  212.      WILL have to install the oasisIII.books.help subsystem, available in the
  213.      oasisIII inst image located in searchtools/dist. There is an older version
  214.      of this help book available in the sifttree.README ascii-text file, but
  215.      this file is not as current as the on-line help system available through
  216.      the motif-based oasisIII GUI after one loads the oasisIII.books.help inst
  217.      subsystem.
  218.  
  219.  
  220.   ____________________________________________________________________________
  221.  
  222.  
  223.  
  224. 3. Ascii version of older OasisIII On-line Help Book:
  225.  
  226.     (In order to access the on-line help inside the oasisIII application, 
  227.     you WILL have to install the oasisIII.books.help subsystem, available 
  228.     in the oasisIII inst image located in searchtools/dist.  The following
  229.     is an older version of this help book in ascii-form, but the rest of
  230.     this file is not as current as the on-line help system available 
  231.     through the motif-based oasisIII GUI after one loads the 
  232.     oasisIII.books.help inst subsystem.)
  233.  
  234.  
  235.  
  236.  
  237.     OasisIII starts a graphical interface used for information retrieval.  
  238.     It allows searching various user-selected databases for keywords.  The 
  239.     program uses a TCP/IP socket to connect to a server process which 
  240.     performs the actual searches, and returns results.  The file ~/.oasisrc
  241.     is read when oasisIII starts for initialization information, such as 
  242.     the server's hostname, default window parameters, maximum hits per 
  243.     search, and more.  A template file of oasisrc is found in 
  244.     /usr/lib/OasisIII.  These entries are not intended to be modified 
  245.     manually, and should instead be manipulated via the Preferences option 
  246.     of the main window.
  247.  
  248.  
  249.     The topics that follow breakdown thusly:
  250.     OasisIII Application - Main Window
  251.     OasisIII - Menubar
  252.     OasisIII - Inquiry Area
  253.     OasisIII - Inquiry Area - Graphical Tree Browsing
  254.     OasisIII - Graphical Tree Controls
  255.     OasisIII - List Browsing
  256.     OasisIII - Search Controls
  257.     OasisIII - Searching / Additional Fields
  258.     OasisIII - Search Syntax
  259.     OasisIII - Documents Area
  260.     OasisIII - Information (Document) Viewer
  261.     OasisIII - Information (Document) Viewer Functions
  262.     OasisIII - Settings Window
  263.     OasisIII - Folder Manager
  264.     OasisIII - Folder Manager Functions
  265.  
  266.  
  267.  
  268.  
  269.  
  270.     OasisIII Application - Main Window
  271.     --------------------------------------------------------------------
  272. This window is used to retrieve information from a database of indexed
  273. document databases. It is the main window that the user interacts with.
  274.  
  275. This is the primary window that is invoked when this application is started
  276. from the command line;  or initiated from the SGI WorkSpace.
  277.  
  278. Due to the abundance of functionality present on this window, the
  279. description of commands and interaction is broken into three sections:
  280. ________________________________________________________________________
  281.  
  282.  
  283.  
  284.  
  285.  
  286.     OasisIII - Menubar
  287.     --------------------------------------------------------------------
  288. This section describes the commands available from the OasisIII Window
  289. menubar.  To access any menu, the user places the cursor over the desired 
  290. item and clicks the left mouse button.  A menu drops down.  The user then 
  291. places the cursor over the desired command they wish to perform from the 
  292. menu and clicks on that entry.
  293.  
  294. "Session" allows you to terminate an OasisIII application session.
  295.  
  296. "Inquiry" allows the user to control the view that is displayed in
  297. the Inquiry area (tree+additional query criteria) of OasisIII.
  298.  
  299. "Documents" allows you to interact with entries displayed in the
  300. multiple-selection document list box, found at the bottom of the
  301.  
  302. Menu    Submenu    Description
  303. ----    -------    -----------
  304. Session
  305.     Quit      Terminates the OasisIII Application. Upon quitting, all
  306.         appropriate state information will be saved in ~/.oasisrc.
  307.  
  308. Inquiry
  309.     Source: [] Graphical View  [] List View
  310.     Topic:  [] Graphical View  [] List View
  311.  
  312.         Toggle allowing the user to switch the tree view they are
  313.         currently accessing and to toggle between viewing the tree
  314.         in graphical form or in list form.
  315.  
  316.         "Source" is meant to give the user a view of actual sources
  317.         that they have available. "Topic" is an abstract view of the
  318.         the information available. It will dynamically construct a
  319.         query based upon the path through the Topic tree that the
  320.         user has chosen.
  321.  
  322. Documents
  323.     Print
  324.     Fax...
  325.     Email...
  326.         For any documents that are in a selected (hilited) state in
  327.         the Document Area list, the user invoke these actions, without
  328.         having to display the document. The user will be prompted for
  329.         more information on entry that is followed by "...".
  330.  
  331.     Sort By: [] Occurrence [] Source  [] Date
  332.         Used as sort criteria for the list of documents returned
  333.         from a search. If a list of documents already exist and
  334.         this is toggled, the list will resort using the new criteria.
  335.  
  336.     Close All
  337.         Closes all Information Viewers currently open.
  338.  
  339. Preferences
  340.     Settings...
  341.         Produces a dialog that displays all current settings for
  342.         the application and allows the user to modify them. See
  343.         See "OasisIII-Settings Window" for further information.
  344.  
  345.     Folder...
  346.         Produces a dialog that displays to the user all current
  347.         inquiries they have saved and all bookmarks they have set.
  348.         See "OasisIII-Folder Window" for further information.
  349. ________________________________________________________________________
  350.  
  351.  
  352.  
  353.  
  354.  
  355.     OasisIII - Inquiry Area
  356.     --------------------------------------------------------------------
  357. From a global perspective, this area allows you to navigate sources or
  358. topics, provide additional keywords, and search across a set of information.
  359.  
  360. Within the navigational region, the user has the capability to browse
  361. information in a tree form by Source or by Topic, to view this information
  362. in Graphical or List form, and access a set of tools that perform specific
  363. tasks upon the tree.
  364.  
  365. Note that this area contains a help message that indicates to the user how
  366. to operate on the tree. This message changes to reflect to the user if they
  367. are viewing a Topic tree, or a Source tree. The message informs the user to
  368. "Click to select <SOURCES or TOPICS>; double-click to expand/contract".  This
  369. message is relevant whether the user is browsing in graphical or list mode.
  370.  
  371. The user can select nodes in the tree, apply any additional query criteria,
  372. and perform a search from within the controls of the Inquiry Area.
  373. ________________________________________________________________________
  374.  
  375.  
  376.  
  377.  
  378.  
  379.     OasisIII - Inquiry Area - Graphical Tree Browsing
  380.     --------------------------------------------------------------------
  381. The user is presented with a graphical "tree" that contains labelled nodes
  382. connected by arcs. This tree represents a logical representation of the
  383. present within the user's view of the knowledge database, or of concepts
  384. (topics) that may be relevant to this user.  All nodes are connected by a
  385. central, or root, node.
  386.  
  387. To expand the nodes of the tree, the user double-clicks on a node, which
  388. produces a list of its immediate children. Double-clicking on a node that
  389. is expanded will collapse it. Nodes that can be expanded contain both a
  390. label, as well as an inverted-triangle symbol (|>).
  391.  
  392. Placing the cursor over any node and clicking the right mouse button
  393. produces a popup menu containing the following commands:
  394.  
  395.     Collapse Subgraph    -Fully collapses the subtree from that node
  396.     Show Immediate Children    -Expands tree out one level from that node
  397.     Show All Children    -Fully expands the subtree from that node
  398.     Search            -Generates a list of documents that
  399.                   correspond to that particular node
  400.     Quick Help        -Invokes a quick help card
  401.  
  402. The first three commands will be greyed if a node has no children.
  403.  
  404. Clicking once on any node places it in a selected state. The node will
  405. turn a specific color to denote that it is currently in that state.
  406. Clicking on a selected node turns off the selection.
  407.  
  408. The user can also "rubber-band" groups of nodes in a put them in a
  409. selected (or unselected) state. Click in the "open area" (NOT on a
  410. node or arc) and hold down the left mouse button to enact this mechanism.
  411.  
  412. Clicking out in the general tree area (not over a node) with the right
  413. mouse button produces a popup menu that operates on all nodes that are
  414. in a SELECTED state. The following commands are available:
  415.  
  416.     Search                -Generates a list of documents for those
  417.                  nodes that are selected
  418.     Quick Help        -Invokes a quick help card
  419. ________________________________________________________________________
  420.  
  421.  
  422.  
  423.  
  424.  
  425.     OasisIII - Graphical Tree Controls
  426.     --------------------------------------------------------------------
  427. The first three controls in the palette deal with zooming the tree.
  428. First is an options-button, labelled with a set of percentages. When the
  429. graph first comes up, this entry is 100%. The user can access this menu
  430. to produce a list of percentages that act as "zoom factors". These range
  431. between 15% and 300%. The font used for the label on the node will scale
  432. up/down, the arcs change to reflect the larger/smaller nodes, and the
  433. tree positions itself according to the centermost node. Up- and Down-arrows
  434. that follow the options-button will move the tree through the zoom factors
  435. in the order they occur in the menu. For example, if the user were to
  436. click on the Up-arrow 3 times, the resultant zoom pattern would be
  437. 150%-200%-300%.
  438.  
  439. The next control available in the palette is an "Overview" button. This
  440. produces a separate window that shows the user the entire tree in a block
  441. diagram. The window contains a hollow-rectangle that overlays the diagram,
  442. showing the current viewable region of the tree. The user can click on
  443. the rectangle and postion it over a portion of the tree they wish to see.
  444. The view in the OasisIII-Window will reflect that portion of the tree, in
  445. real-time. Both sizing the OasisIII-Window and scrolling via the scrollbars
  446. on the tree will also cause an update to the overview window.
  447.  
  448. Finally, the user may wish to rotate the tree so that it appears in a
  449. top-down(vertical) versus left-right (horizontal-the default) style
  450. of presentation. The control that provides that functionality is the
  451. "Rotate" button (LAST button in the pallete).
  452. ________________________________________________________________________
  453.  
  454.  
  455.  
  456.  
  457.  
  458.     OasisIII - List Browsing
  459.     --------------------------------------------------------------------
  460. The user can traverse through the various Sources of information or
  461. Topics in a list manner. To toggle this option use the "Inquiry" menu.
  462.  
  463. Navigating through a list-oriented tree is similar to navigating the
  464. graphical representation of the tree.
  465.  
  466. List entries that can be expanded are followed by a textual symbol of ">>".
  467. Double-click expands (contracts) the list entries in-line, displaying
  468. (removing) their children.
  469.  
  470. A single-click selects that entry. Turning off the selection is done
  471. by clicking again on that selected entry.
  472.  
  473. Placing the cursor over any node and clicking the right mouse button
  474. produces a popup menu containing the following commands:
  475.  
  476.         Collapse Children       -Fully collapses the subtree from that
  477. node
  478.         Show Immediate Children -Expands tree out one level from that node
  479.         Show All Children       -Fully expands the subtree from that node
  480.         Search                  -Generates a list of documents that
  481.                                  correspond to that particular node
  482.         Quick Help              -Invokes a quick help card
  483.  
  484. The first three commands will be greyed if a node has no children.
  485.  
  486. Clicking out in the general tree area (not over a node) with the right
  487. mouse button produces a popup menu that operates on all nodes that are
  488. in a SELECTED state. The following commands are available:
  489.  
  490.         Search                  -Generates a list of documents for those
  491.                                  nodes that are selected
  492.         Quick Help              -Invokes a quick help card
  493. ________________________________________________________________________
  494.  
  495.  
  496.  
  497.  
  498.  
  499.     OasisIII - Search Controls
  500.     --------------------------------------------------------------------
  501. Following the additional fields, there is are controls that work in
  502. conjunction with the search operation.
  503.  
  504. Control        Description
  505. -------         -----------
  506. Search        Performs a search using Topic and/or Source information
  507.         AND any additional field information.
  508.  
  509. Narrow        Search a previously retrieved set of documents. This
  510.         inquiry only searches against that set.
  511.  
  512. Save         Save all search criteria (including tree information).
  513.         You will be prompted to provide a "user label" to assign
  514.         to this saved inquiry. For re-invocation, see "Folder Manager".
  515.  
  516. Clear        Clears out the edit fields only. Does not reset the tree
  517.         information, nor erase a document set retrieved via a search.
  518. ________________________________________________________________________
  519.  
  520.  
  521.  
  522.  
  523.  
  524.     OasisIII - Searching / Additional Fields
  525.     --------------------------------------------------------------------
  526. "Enter" from any field will cause a search to be performed. For information
  527. on Search Syntax, see "OasisIII - Search Syntax".
  528.  
  529. Field        Description
  530. -----         -----------
  531. Keywords    Searches the "generic" content of all documents.
  532.  
  533. Title        Only searches in the document title string. Very fast
  534.         search. Good for delimiting/narrowing.
  535.  
  536. Filename        Searches in the document filename field.  Could search
  537.         with just extensions, or any part of the file (or file
  538.         path) specified.
  539.  
  540. Date        Accepts a date string in virtually any format. Will do
  541.         its best to convert it and look for documents that have
  542.             date values that fall into the specified range. To ensure
  543.         proper conversion, "YYMMDD" is a form that works.
  544. ________________________________________________________________________
  545.  
  546.  
  547.  
  548.  
  549.  
  550.     OasisIII - Search Syntax
  551.     --------------------------------------------------------------------
  552. Besides producing documents via the browsing methods, users may also
  553. use the additional fields to qualify their searches further.  These
  554. additional fields support full boolean constructs. Users may define
  555. queries using any combination of ANDs, ORs, NOTs, and paranthetical
  556. expressions. For example, to find documents that deal with tape drives
  557. and also find any documents dealing with non-scsi disk errors, the
  558. user could formulate the following query:
  559.  
  560.     (TAPE and DRIVE) or (NOT SCSI and (DISK and ERROR)).
  561.  
  562. Note that the system also supports the following operators:
  563.  
  564.     [term1 term2]    -Proximity-find documents containing the terms
  565.                 a set distance from each other.
  566.     "term1 term2"    -Phrase-find documents containing both terms
  567.                 in the given order, next to each other.
  568.     term*        -Expansion-look for any document with word(s)
  569.                     containing the base term.
  570.     term?        -Wildcard-find any document with word(s)
  571.                 containing the base term and any
  572.                   ONE character following that term.
  573.  
  574.  
  575. Notes: " " (blank space) is a logical AND condition.
  576. ________________________________________________________________________
  577.  
  578.  
  579.  
  580.  
  581.  
  582.     OasisIII - Documents Area
  583.     --------------------------------------------------------------------
  584. This area of the Knowledge Retrieval Window is used to display the list
  585. of documents that results from a search, and a count of how many were found.
  586. Items from the list of found documents can be selected, sorted, displayed,
  587. or sent to other output channels.
  588.  
  589. The Documents Section is located at the bottom of the OasisIII window.
  590. Note that this area is a Motif "pane", capable of being independently
  591. collapsed/sized within the entire window. Click on the rectangle above
  592. and to the right of the list. Hold the mouse button down and drag the
  593. pane up or down. Note the change in size/layout.
  594.  
  595. Below the text labels that indicate the number of documents found via a
  596. search and a simple help message, is a scrollable(horizontal and vertical),
  597. multiple-selection list containing titles of the documents retrieved via
  598. a search.
  599.  
  600. The results are sorted as specified by the user and can be changed from
  601. within the "Documents" menu. See "OasisIII - Menubar" for more information.
  602.  
  603. A scrollbar allows scrolling through the list.  The user can single click
  604. the left mouse button on an entry in the list, to select that entry. This
  605. causes that entry to be hilited. The user may perform actions on the set
  606. of documents that have been selected, by using the actions in the "Documents"
  607. menu. Subsequent single, left-mouse clicks on selected items cause the
  608. item to become "unselected".
  609.  
  610. Double-clicking the left mouse button on an entry in the list causes that
  611. item to be displayed, either in the current active viewer window (if one
  612. is in use), or in a newly-created viewer window (see "OasisIII-Information
  613. Viewer").
  614. ________________________________________________________________________
  615.  
  616.  
  617.  
  618.  
  619.  
  620.     OasisIII - Information (Document) Viewer
  621.     --------------------------------------------------------------------
  622. This window is used to view (read, browse, ...) documents. It is displayed
  623. via a double-click on a document in the OasisIII window Document List that
  624. was retrieved from a search; or it can be invoked from a bookmark entry in
  625. the Folder Manager Window. Note that the document is not editable.
  626. ________________________________________________________________________
  627.  
  628.  
  629.  
  630.  
  631.  
  632.     OasisIII - Information (Document) Viewer Functions
  633.     --------------------------------------------------------------------
  634. Menu    Submenu Description
  635. ----    ------- -----------
  636. Session
  637.         Quit    Closes the current Information Viewer (only).
  638.  
  639. Documents
  640.      Copy..., Email..., Fax..., Print
  641.         For the document currently in the Viewer, the desired action
  642.         will be performed. The user will be prompted for more
  643.                 information on entry that is followed by "...".
  644.     Search
  645.         Will perform an in-document search using the string that
  646.         the user provides. Terms found within the document will be
  647.         shown in a different color both in the scrollbar area as
  648.         well as within the document.
  649.     Bookmark
  650.         Will prompt the user for a label to assign to this document.
  651.         Bookmark entries can be accessed/invoked via the Folder
  652.         Manager.
  653. ________________________________________________________________________
  654.  
  655.  
  656.  
  657.  
  658.  
  659.     OasisiIII Information Viewer Functions
  660.     --------------------------------------------------------------------
  661. Control Area
  662.  
  663. Scrolling is provided via Motif horizontal and vertical scroll bars. The
  664. colors in the scrollbar area indicate the presence of search terms. One
  665. color is used to denote the search criteria used in the OasisIII window,
  666. and another for the in-document search terms. The window will automatically
  667. scroll to the first area that contains search terms.
  668.  
  669. Keywords: Next, Previous
  670.  
  671. The Next/Prev buttons allow navigating through the current document using
  672. the keywords. The Next button will find the next keyword in the document
  673. from the current position, scroll if necessary, and highlight the word
  674. with a different color.
  675.  
  676. Document: Next, Previous
  677.  
  678. These commands allow scrolling through the list of documents resulting from
  679. a search in the OasisIII window. The Next/Prev buttons apply to all documents
  680. in the list, regardless of whether a document has been selected or not.
  681. When these buttons are used to traverse the Document list, the list entry
  682. that corresponds to the currently viewed document will be represented in
  683. a different color. Other documents that are displayed, but not in the active
  684. viewer will also be represented in the Document list in yet another color.
  685.  
  686. Active Viewer
  687.  
  688. This toggle indicates which Viewer within the application is considered to
  689. be "active". If this is turned off by clicking on the label, then the next
  690. document will be brought up in it's own window, and that window will now
  691. become the "active viewer".
  692. ________________________________________________________________________
  693.  
  694.  
  695.  
  696.  
  697.  
  698.     OasisIII - Settings Window
  699.     --------------------------------------------------------------------
  700. The Settings window is used to set up the location of the databases to be
  701. used, to set a maximum hit count, to define what a "near" distance is,
  702. to toggle the use of a thesaurus, to set up a printer, etc.
  703.  
  704. Public Path:       Where the OasisIII databases are mounted
  705.  
  706. Fax Server:       Which machine is the fax server for your client
  707.  
  708. Near Distance:       When searching using "[" and "]", the proximity
  709. operators,
  710.            how many characters should be used in computing this
  711.            distance. The default is 72 (~1 line).
  712.  
  713. Maximum Hit Count: Ceiling on the number of documents to return from a
  714.            search. Default is 250. Maximum is 1000.
  715.  
  716. When the Settings window comes up, it shows the default values for each
  717. of the fields that can be set.  Move the mouse pointer to the field you
  718. wish to change, and backspaces over (or cut) the default value, replacing
  719. it with your own value.
  720.  
  721. To toggle thesaurus usage, click the left mouse button on the label titled
  722. "Use Thesaurus?". This will change the color of the toggle box to the left
  723. of the label.
  724.  
  725. To select a printer, click the left mouse button on your choice from the
  726. list provided.
  727.  
  728. When all the selections are made, click the left mouse button on either
  729. the "Save" button to make the changes take effect, or the "Cancel" button
  730. to abort the operation and return to the OasisIII window.
  731. ________________________________________________________________________
  732.  
  733.  
  734.  
  735.  
  736.  
  737.     OasisIII - Folder Manager
  738.     --------------------------------------------------------------------
  739. The purpose of the Folder Manager is to provide alternate entry points
  740. to the data in the OasisIII database. These points are currently Saved
  741. Inquiries and Bookmarks.
  742.  
  743. The Folder allows the user to filter which of the types of entries they
  744. will view, and to invoke or delete these entries from within this window.
  745. ________________________________________________________________________
  746.  
  747.  
  748.  
  749.  
  750.  
  751.     OasisIII - Folder Manager Functions
  752.     --------------------------------------------------------------------
  753. Events
  754.  
  755. You may selectively choose which entry points to view by using the Events
  756. toggle. The default is to display both Saved Inquiries and Bookmarks.
  757. Clicking on the label of these will turn the access to those points on/off,
  758. and the list will dynamically change to reflect the filter criteria.
  759.  
  760. Invoke
  761.  
  762. To invoke an entry point, select (click) an event that appears in the list
  763. displayed by the Folder Manager and then click on the "Invoke" pushbutton.
  764. This can also be performed by double-clicking on the event in the list.
  765.  
  766. Delete
  767.  
  768. An event can be deleted by selecting it from the list and then clicking
  769. the "Delete" pushbutton. Accidental deletions cannot be restored at this
  770. time.
  771. ________________________________________________________________________
  772.